/*
 * Copyright 2012-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.autoconfigure.elasticsearch;

import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.config.RequestConfig.Builder;
import org.apache.http.impl.nio.client.HttpAsyncClientBuilder;
import org.elasticsearch.client.RestClientBuilder;

/**
 * 一个回调接口，可由希望通过 {@link RestClientBuilder} 进一步定制
 * {@link org.elasticsearch.client.RestClient} 的 Bean 实现，同时保留默认的自动配置。
 *
 * @author Brian Clozel
 * @author Vedran Pavic
 * @since 2.1.0
 */
@FunctionalInterface
public interface RestClientBuilderCustomizer {

	/**
	 * 自定义 {@link RestClientBuilder}。
	 * <p>
	 * 可能会覆盖使用 {@code "spring.elasticsearch.rest"}
	 * 配置属性命名空间进行的自定义。对于更有针对性的更改，请参阅
	 * {@link #customize(HttpAsyncClientBuilder)} 和
	 * {@link #customize(RequestConfig.Builder)}。
	 * @param builder 要自定义的构建器
	 */
	void customize(RestClientBuilder builder);

	/**
	 * 自定义 {@link HttpAsyncClientBuilder}。
	 * @param builder 构建器
	 * @since 2.3.0
	 */
	default void customize(HttpAsyncClientBuilder builder) {
	}

	/**
	 * 自定义 {@link Builder}。
	 * @param builder 构建器
	 * @since 2.3.0
	 */
	default void customize(Builder builder) {
	}

}
